GET Audio by ID

Overview

---

The table below provides information about the GET method for managing the process of retrieving an audio by its ID.

GET Audio by PublicId
Method	GET
URL or Endpoint	/api/v1/projectId/audios/id
Headers	Authorization
Parameters	id, projectId
Body	Not Applicable

The description of the URL parameter is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique Id of the audio.

Request Body

The GET method doesn't contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{audioId}",
    "title": "{title}",
    "description": "{description}",
    "source": "{source}",
    "author": "{author}",
    "publishStatusName": "Ready",
    "thumbnail": "{thumbnailUrl}",
    "canEmbed": true,
    "link": "{link}",
    "chapterState": true,
    "duration": 93.727347,
    "publishStartDate": "2024-05-20T14:10:01.924Z",
    "publishEndDate": "2024-06-20T14:10:01.924Z",
    "insertDate": "2024-05-20T14:10:01.9248475",
    "customParameters": [],
    "adScheduleId": "{adScheduleId}",
    "chapters": [
      {
        "title": "{chapterTitle}",
        "time": 0
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false
errors	array[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	object	Returns the response object
publicId	string	The unique Id of the audio
title	string	Title of the audio
description	string	Description of the audio
source	string	The source of the audio.
author	string	The author of the audio.
publishStatusName	string	Name of the publish status.
thumbnail	string	URL of the audio's thumbnail image
canEmbed	boolean	Indicates whether the audio can be embedded.
link	string	Url of the embed.
chapterState	boolean	Indicates whether chapters are enabled
duration	string	Duration of the audio in seconds
publishStartDate	string($date-time)	Date and time when the audio was published
publishEndDate	string($date-time)	Date and time when audio will not be available.
insertDate	string($date-time)	Date and time when the audio was inserted
adScheduleId	string	The public ID of the ad schedule associated with the audio.
customParameters	array[object]	An array of custom parameters.
chapters	array[object]	Returns an array of chapters.
resultInfo	string	Returns extra information about the result
statusCode	integer	Returns the HTTP Status Code

customParameters Properties

Field Name	Type	Description
key	string	Key of the custom parameter.
value	string	Value of the custom parameter.

chapters Properties

Field Name	Type	Description
title	string	The title of the chapter.
time	integer	The end time for the specific chapter.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed